Skip to content

feat(status-roles): add cog to assign roles based on user status #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 19, 2025
Merged

feat(status-roles): add cog to assign roles based on user status #789

merged 3 commits into from
Apr 19, 2025

Conversation

electron271
Copy link
Contributor

@electron271 electron271 commented Mar 24, 2025 •
edited by sourcery-ai bot
Loading

Description

add automatically giving roles based on status

Guidelines

  • My code follows the style guidelines of this project (formatted with Ruff)

  • I have performed a self-review of my own code

  • I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation if needed

  • My changes generate no new warnings

  • I have tested this change

  • Any dependent changes have been merged and published in downstream modules

  • I have added all appropriate labels to this PR

  • I have followed all of these guidelines.

How Has This Been Tested? (if applicable)

ran it with regex "test" and changed status

Summary by Sourcery

Adds a cog that automatically assigns roles to users based on their status, using regular expressions to match against the user's custom status. The cog checks and updates roles on startup and when a user's presence changes.

New Features:

  • Introduces a cog that automatically assigns roles to users based on their status.
  • Adds a configuration option to define status-to-role mappings using regular expressions.
  • The cog checks and updates roles on startup and when a user's presence changes.
  • Adds logging for role assignments, removals, and errors related to status role automation.

@electron271 electron271 requested a review from kzndotsh March 24, 2025 00:16
@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Mar 24, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a new cog, StatusRoles, that automatically assigns and removes roles from users based on their custom Discord status. It reads configuration from CONFIG.STATUS_ROLES, which defines the mapping between regular expressions and role IDs. The cog listens for presence updates and periodically checks all members to ensure their roles match their current status.

Sequence diagram for status role assignment

sequenceDiagram
    participant User
    participant DiscordClient
    participant StatusRolesCog
    participant DiscordAPI

    User->>DiscordClient: Updates status
    DiscordClient->>StatusRolesCog: on_presence_update(before, after)
    StatusRolesCog->>StatusRolesCog: get_custom_status(member)
    StatusRolesCog->>StatusRolesCog: has_activity_changed(before, after)
    StatusRolesCog->>StatusRolesCog: check_and_update_roles(member)
    StatusRolesCog->>StatusRolesCog: get_custom_status(member)
    StatusRolesCog->>StatusRolesCog: for each config in STATUS_ROLES
    StatusRolesCog->>StatusRolesCog: re.search(pattern, status_text)
    alt matches and not has_role
        StatusRolesCog->>DiscordAPI: member.add_roles(role)
        DiscordAPI-->>StatusRolesCog: Role added
    else not matches and has_role
        StatusRolesCog->>DiscordAPI: member.remove_roles(role)
        DiscordAPI-->>StatusRolesCog: Role removed
    end
Loading

File-Level Changes

Change Details Files
Introduced a new cog to manage roles based on user status.
  • Created StatusRoles cog with listeners for on_ready and on_presence_update.
  • Implemented check_and_update_roles to add or remove roles based on status regex matching.
  • Added get_custom_status to extract custom status text from a member's activities.
  • Included error handling for invalid regex patterns and permission issues.
  • Added logging for role assignments, removals, and errors.
 tux/cogs/services/status_roles.py
Added a new configuration parameter for status roles.
  • Added STATUS_ROLES to the Config class to store status role configurations.
  • Updated Config initialization to load STATUS_ROLES from the config file.
 tux/utils/config.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 24, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @electron271 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a more specific exception handler for discord.Forbidden to differentiate between missing permissions to add vs remove roles.
  • It might be helpful to include the server ID in the log messages for easier debugging.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

electron271 and others added 2 commits April 19, 2025 16:44
@electron271
Merge branch 'main' into statusroles
debac7d
@electron271 @sourcery-ai
Update tux/cogs/services/status_roles.py
3d257ab 
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
electron271
electron271 commented Apr 19, 2025
View reviewed changes
Copy link
Contributor Author

@electron271 electron271 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works, tested again

@electron271 electron271 merged commit 55e6e75 into main Apr 19, 2025
8 checks passed
@electron271 electron271 deleted the statusroles branch April 19, 2025 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@kzndotsh kzndotsh Awaiting requested review from kzndotsh

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@electron271